IRIX Base Documentation 2001 May

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XAllocSizeHints.z / XAllocSizeHints

Wrap

Text File | 1998-10-30 | 16.9 KB | 507 lines

XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) NNNNAAAAMMMMEEEE XAllocSizeHints, XSetWMNormalHints, XGetWMNormalHints, XSetWMSizeHints, XGetWMSizeHints, XSizeHints - allocate size hints structure and set or read a window's WM_NORMAL_HINTS property SSSSYYYYNNNNTTTTAAAAXXXX XSizeHints *XAllocSizeHints() void XSetWMNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s) Display *_d_i_s_p_l_a_y; Window _w; XSizeHints *_h_i_n_t_s; Status XGetWMNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s__r_e_t_u_r_n, _s_u_p_p_l_i_e_d__r_e_t_u_r_n) Display *_d_i_s_p_l_a_y; Window _w; XSizeHints *_h_i_n_t_s__r_e_t_u_r_n; long *_s_u_p_p_l_i_e_d__r_e_t_u_r_n; void XSetWMSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s, _p_r_o_p_e_r_t_y) Display *_d_i_s_p_l_a_y; Window _w; XSizeHints *_h_i_n_t_s; Atom _p_r_o_p_e_r_t_y; Status XGetWMSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s__r_e_t_u_r_n, _s_u_p_p_l_i_e_d__r_e_t_u_r_n, _p_r_o_p_e_r_t_y) Display *_d_i_s_p_l_a_y; Window _w; XSizeHints *_h_i_n_t_s__r_e_t_u_r_n; long *_s_u_p_p_l_i_e_d__r_e_t_u_r_n; Atom _p_r_o_p_e_r_t_y; AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS _d_i_s_p_l_a_y Specifies the connection to the X server. _h_i_n_t_s Specifies the size hints for the window in its normal state. _h_i_n_t_s Specifies the _X_S_i_z_e_H_i_n_t_s structure to be used. _h_i_n_t_s__r_e_t_u_r_n Returns the size hints for the window in its normal state. _p_r_o_p_e_r_t_y Specifies the property name. _s_u_p_p_l_i_e_d__r_e_t_u_r_n Returns the hints that were supplied by the user. Page 1 (printed 4/30/98) XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) _w Specifies the window. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The _X_A_l_l_o_c_S_i_z_e_H_i_n_t_s function allocates and returns a pointer to a _X_S_i_z_e_H_i_n_t_s structure. Note that all fields in the _X_S_i_z_e_H_i_n_t_s structure are initially set to zero. If insufficient memory is available, _X_A_l_l_o_c_S_i_z_e_H_i_n_t_s returns NULL. To free the memory allocated to this structure, use _X_F_r_e_e. The _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function replaces the size hints for the WM_NORMAL_HINTS property on the specified window. If the property does not already exist, _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s sets the size hints for the WM_NORMAL_HINTS property on the specified window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors. The _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function returns the size hints stored in the WM_NORMAL_HINTS property on the specified window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s sets the various fields of the _X_S_i_z_e_H_i_n_t_s structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a zero status. If _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: (USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) If the property is large enough to contain the base size and window gravity fields as well, the supplied_return argument will also contain the following bits: PBaseSize|PWinGravity _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s can generate a PN BadWindow error. The _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s function replaces the size hints for the specified property on the named window. If the specified property does not already exist, _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s sets the size hints for the specified property on the named window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. To set a window's normal size hints, you can Page 2 (printed 4/30/98) XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) use the _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function. _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, and _B_a_d_W_i_n_d_o_w errors. The _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s function returns the size hints stored in the specified property on the named window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s sets the various fields of the _X_S_i_z_e_H_i_n_t_s structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a zero status. To get a window's normal size hints, you can use the _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function. If _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: (USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) If the property is large enough to contain the base size and window gravity fields as well, the supplied_return argument will also contain the following bits: PBaseSize|PWinGravity _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors. PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS WM_NORMAL_HINTS Size hints for a window in its normal state. The C type of this property is _X_S_i_z_e_H_i_n_t_s. SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS The _X_S_i_z_e_H_i_n_t_s structure contains: /* Size hints mask bits */ #define _U_S_P_o_s_i_t_i_o_n (1L << 0) /* user specified x, y */ #define _U_S_S_i_z_e (1L << 1) /* user specified width, height */ #define _P_P_o_s_i_t_i_o_n (1L << 2) /* program specified position */ #define _P_S_i_z_e (1L << 3) /* program specified size */ #define _P_M_i_n_S_i_z_e (1L << 4) /* program specified minimum size */ #define Page 3 (printed 4/30/98) XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) _P_M_a_x_S_i_z_e (1L << 5) Page 4 (printed 4/30/98) XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) /* program specified maximum size */ Page 5 (printed 4/30/98) XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) #define _P_R_e_s_i_z_e_I_n_c (1L << 6) /* program specified resize increments */ #define _P_A_s_p_e_c_t (1L << 7) /* program specified min and max aspect ratios */ #define _P_B_a_s_e_S_i_z_e (1L << 8) #define _P_W_i_n_G_r_a_v_i_t_y (1L << 9) #define _P_A_l_l_H_i_n_t_s (PPosition|PSize| PMinSize|PMaxSize| PResizeInc|PAspect) /* Values */ typedef struct { long flags; /* marks which fields in this structure are defined */ int x, y; /* Obsolete */ int width, height; /* Obsolete */ int min_width, min_height; int max_width, max_height; int width_inc, height_inc; struct { int x; /* numerator */ int y; /* denominator */ } min_aspect, max_aspect; int base_width, base_height; int win_gravity; /* this structure may be extended in the future */ } XSizeHints; The x, y, width, and height members are now obsolete and are left solely for compatibility reasons. The min_width and min_height members specify the minimum window size that still allows the application to be useful. The max_width and max_height members specify the maximum window size. The width_inc and height_inc members define an arithmetic progression of sizes (minimum to maximum) into which the window prefers to be resized. The min_aspect and max_aspect members are expressed as ratios of x and y, and they allow an application to specify the range of aspect ratios it prefers. The base_width and base_height members define the desired size of the window. The window manager will interpret the position of the window and its border width to position the point of the outer rectangle of the overall window specified by the win_gravity member. The outer rectangle of the window includes any borders or decorations supplied by the window manager. In other words, if the window manager decides to place the window where the client asked, the position on the parent window's border named by the win_gravity will be placed where the client window would have been placed in the absence of a window manager. Note that use of the _P_A_l_l_H_i_n_t_s macro is highly discouraged. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS PPPPaaaaggggeeee 6666 ((((pppprrrriiiinnnntttteeeedddd 4444////33330000////99998888)))) XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXAAAAllllllllooooccccSSSSiiiizzzzeeeeHHHHiiiinnnnttttssss((((3333XXXX11111111)))) _B_a_d_A_l_l_o_c The server failed to allocate the requested resource or server memory. _B_a_d_A_t_o_m A value for an Atom argument does not name a defined Atom. _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a defined Window. SSSSEEEEEEEE AAAALLLLSSSSOOOO XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11) _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e Page 7 (printed 4/30/98)